Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(smoketest): add Opensearch as a sample app #570

Merged
merged 7 commits into from
Jul 19, 2024
Merged

feat(smoketest): add Opensearch as a sample app #570

merged 7 commits into from
Jul 19, 2024

Conversation

tthvo
Copy link
Member

@tthvo tthvo commented Jul 19, 2024

Welcome to Cryostat! 👋

Before contributing, make sure you have:

  • Read the contributing guidelines
  • Linked a relevant issue which this PR resolves
  • Linked any other relevant issues, PR's, or documentation, if any
  • Resolved all conflicts, if any
  • Rebased your branch PR on top of the latest upstream main branch
  • Attached at least one of the following labels to the PR: [chore, ci, docs, feat, fix, test]
  • Signed all commits using a GPG signature

To recreate commits with GPG signature git fetch upstream && git rebase --force --gpg-sign upstream/main

Related to #403

Description of the change:

  • Added OpenSearch as a sample application. OpenSearch is configured to run as a single node with JFR and JMX enabled.
  • Also added an Opensearch Dashboard to work with Opensearch if needed.
  • Some cleanups:
    • Ignore generated certs and keys.
    • Update scripts to create directory when necessary.
    • Ignored failed rm operations. For example, when the certs are not present.

Motivation for the change:

See #403. OpenSearch is a pretty popular search engine, written Java. I think it's good to have Cryostat tested against it. I guess we can later add a minimal ElasticSearch + Kibana.

How to manually test:

bash smoketest -t

To access opensearch dashboard, visit: http://localhost:5601 with credentials: admin/password4Opense@rch

Others

I am thinking the smoketest script can categorize the types of sample apps. For example, basic, basic-with-agent, search, etc. Then, we can run bash smoketest -t basic,search.

tthvo added 4 commits July 18, 2024 23:02
@tthvo
feat(compose): add opensearch as a sample app
9ab085d 
OpenSearch is an opensource Java application for searches and analytics for large data. This presents a real-world example application to test Cryostat against.

Signed-off-by: Thuan Vo <[email protected]>
@tthvo
fix(smoketest): ignore failed rm ops and create dirs if necessary
1791754
@tthvo
feat(smoketest): include opensearch in smoketest
cad88a4
@tthvo
fix(git): ignore generated certs and keys
99a8a94
@tthvo tthvo added feat New feature or request fix safe-to-test labels Jul 19, 2024
@github-actions github-actions bot added the needs-triage Needs thorough attention from code reviewers label Jul 19, 2024
@tthvo tthvo requested a review from a team July 19, 2024 07:45
@tthvo tthvo added test and removed needs-triage Needs thorough attention from code reviewers labels Jul 19, 2024
@andrewazores
Copy link
Member

I am thinking the smoketest script can categorize the types of sample apps. For example, basic, basic-with-agent, search, etc. Then, we can run bash smoketest -t basic,search.

This is a good idea, since running all of the sample apps ends up taking more and more resources on the workstation (and more time to pull and start containers) and may not always be desired. But -t alone, or -t all, should still be available so we can run everything at once to provide a full test suite without having to restart the smoketest to test against different things.

@tthvo tthvo mentioned this pull request Jul 19, 2024
Closed
@andrewazores andrewazores merged commit c25c4a7 into cryostatio:main Jul 19, 2024
8 checks passed
@tthvo tthvo deleted the opensearch-sample-app branch July 19, 2024 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andrewazores andrewazores andrewazores approved these changes

Assignees
No one assigned
Labels
feat New feature or request fix safe-to-test test
Projects
4.0.0 release
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tthvo @andrewazores